<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Caffe: include/caffe/solver.hpp Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">Caffe
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_4b7f3da7c7b4301d805dae0326fb91b7.html">caffe</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="headertitle">
<div class="title">solver.hpp</div>  </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno">    1</span>&#160;<span class="preprocessor">#ifndef CAFFE_SOLVER_HPP_</span></div><div class="line"><a name="l00002"></a><span class="lineno">    2</span>&#160;<span class="preprocessor">#define CAFFE_SOLVER_HPP_</span></div><div class="line"><a name="l00003"></a><span class="lineno">    3</span>&#160;<span class="preprocessor">#include &lt;boost/function.hpp&gt;</span></div><div class="line"><a name="l00004"></a><span class="lineno">    4</span>&#160;<span class="preprocessor">#include &lt;string&gt;</span></div><div class="line"><a name="l00005"></a><span class="lineno">    5</span>&#160;<span class="preprocessor">#include &lt;vector&gt;</span></div><div class="line"><a name="l00006"></a><span class="lineno">    6</span>&#160;</div><div class="line"><a name="l00007"></a><span class="lineno">    7</span>&#160;<span class="preprocessor">#include &quot;caffe/net.hpp&quot;</span></div><div class="line"><a name="l00008"></a><span class="lineno">    8</span>&#160;<span class="preprocessor">#include &quot;caffe/solver_factory.hpp&quot;</span></div><div class="line"><a name="l00009"></a><span class="lineno">    9</span>&#160;<span class="preprocessor">#include &quot;caffe/util/benchmark.hpp&quot;</span></div><div class="line"><a name="l00010"></a><span class="lineno">   10</span>&#160;</div><div class="line"><a name="l00011"></a><span class="lineno">   11</span>&#160;<span class="keyword">namespace </span><a class="code" href="namespacecaffe.html">caffe</a> {</div><div class="line"><a name="l00012"></a><span class="lineno">   12</span>&#160;</div><div class="line"><a name="l00021"></a><span class="lineno"><a class="line" href="namespacecaffe_1_1SolverAction.html">   21</a></span>&#160;  <span class="keyword">namespace </span>SolverAction {</div><div class="line"><a name="l00022"></a><span class="lineno">   22</span>&#160;    <span class="keyword">enum</span> Enum {</div><div class="line"><a name="l00023"></a><span class="lineno">   23</span>&#160;      NONE = 0,  <span class="comment">// Take no special action.</span></div><div class="line"><a name="l00024"></a><span class="lineno">   24</span>&#160;      STOP = 1,  <span class="comment">// Stop training. snapshot_after_train controls whether a</span></div><div class="line"><a name="l00025"></a><span class="lineno">   25</span>&#160;                 <span class="comment">// snapshot is created.</span></div><div class="line"><a name="l00026"></a><span class="lineno">   26</span>&#160;      SNAPSHOT = 2  <span class="comment">// Take a snapshot, and keep training.</span></div><div class="line"><a name="l00027"></a><span class="lineno">   27</span>&#160;    };</div><div class="line"><a name="l00028"></a><span class="lineno">   28</span>&#160;  }</div><div class="line"><a name="l00029"></a><span class="lineno">   29</span>&#160;</div><div class="line"><a name="l00033"></a><span class="lineno"><a class="line" href="namespacecaffe.html#a79ce9ffbdd44b367252e0b8cf99bf430">   33</a></span>&#160;<span class="keyword">typedef</span> boost::function&lt;SolverAction::Enum()&gt; <a class="code" href="namespacecaffe.html#a79ce9ffbdd44b367252e0b8cf99bf430">ActionCallback</a>;</div><div class="line"><a name="l00034"></a><span class="lineno">   34</span>&#160;</div><div class="line"><a name="l00041"></a><span class="lineno">   41</span>&#160;<span class="keyword">template</span> &lt;<span class="keyword">typename</span> Dtype&gt;</div><div class="line"><a name="l00042"></a><span class="lineno"><a class="line" href="classcaffe_1_1Solver.html">   42</a></span>&#160;<span class="keyword">class </span><a class="code" href="classcaffe_1_1Solver.html">Solver</a> {</div><div class="line"><a name="l00043"></a><span class="lineno">   43</span>&#160; <span class="keyword">public</span>:</div><div class="line"><a name="l00044"></a><span class="lineno">   44</span>&#160;  <span class="keyword">explicit</span> <a class="code" href="classcaffe_1_1Solver.html">Solver</a>(<span class="keyword">const</span> SolverParameter&amp; param);</div><div class="line"><a name="l00045"></a><span class="lineno">   45</span>&#160;  <span class="keyword">explicit</span> <a class="code" href="classcaffe_1_1Solver.html">Solver</a>(<span class="keyword">const</span> <span class="keywordtype">string</span>&amp; param_file);</div><div class="line"><a name="l00046"></a><span class="lineno">   46</span>&#160;  <span class="keywordtype">void</span> Init(<span class="keyword">const</span> SolverParameter&amp; param);</div><div class="line"><a name="l00047"></a><span class="lineno">   47</span>&#160;  <span class="keywordtype">void</span> InitTrainNet();</div><div class="line"><a name="l00048"></a><span class="lineno">   48</span>&#160;  <span class="keywordtype">void</span> InitTestNets();</div><div class="line"><a name="l00049"></a><span class="lineno">   49</span>&#160;</div><div class="line"><a name="l00050"></a><span class="lineno">   50</span>&#160;  <span class="comment">// Client of the Solver optionally may call this in order to set the function</span></div><div class="line"><a name="l00051"></a><span class="lineno">   51</span>&#160;  <span class="comment">// that the solver uses to see what action it should take (e.g. snapshot or</span></div><div class="line"><a name="l00052"></a><span class="lineno">   52</span>&#160;  <span class="comment">// exit training early).</span></div><div class="line"><a name="l00053"></a><span class="lineno">   53</span>&#160;  <span class="keywordtype">void</span> SetActionFunction(ActionCallback func);</div><div class="line"><a name="l00054"></a><span class="lineno">   54</span>&#160;  SolverAction::Enum GetRequestedAction();</div><div class="line"><a name="l00055"></a><span class="lineno">   55</span>&#160;  <span class="comment">// The main entry of the solver function. In default, iter will be zero. Pass</span></div><div class="line"><a name="l00056"></a><span class="lineno">   56</span>&#160;  <span class="comment">// in a non-zero iter number to resume training for a pre-trained net.</span></div><div class="line"><a name="l00057"></a><span class="lineno">   57</span>&#160;  <span class="keyword">virtual</span> <span class="keywordtype">void</span> Solve(<span class="keyword">const</span> <span class="keywordtype">char</span>* resume_file = NULL);</div><div class="line"><a name="l00058"></a><span class="lineno">   58</span>&#160;  <span class="keyword">inline</span> <span class="keywordtype">void</span> Solve(<span class="keyword">const</span> <span class="keywordtype">string</span> resume_file) { Solve(resume_file.c_str()); }</div><div class="line"><a name="l00059"></a><span class="lineno">   59</span>&#160;  <span class="keywordtype">void</span> Step(<span class="keywordtype">int</span> iters);</div><div class="line"><a name="l00060"></a><span class="lineno">   60</span>&#160;  <span class="comment">// The Restore method simply dispatches to one of the</span></div><div class="line"><a name="l00061"></a><span class="lineno">   61</span>&#160;  <span class="comment">// RestoreSolverStateFrom___ protected methods. You should implement these</span></div><div class="line"><a name="l00062"></a><span class="lineno">   62</span>&#160;  <span class="comment">// methods to restore the state from the appropriate snapshot type.</span></div><div class="line"><a name="l00063"></a><span class="lineno">   63</span>&#160;  <span class="keywordtype">void</span> Restore(<span class="keyword">const</span> <span class="keywordtype">char</span>* resume_file);</div><div class="line"><a name="l00064"></a><span class="lineno">   64</span>&#160;  <span class="comment">// The Solver::Snapshot function implements the basic snapshotting utility</span></div><div class="line"><a name="l00065"></a><span class="lineno">   65</span>&#160;  <span class="comment">// that stores the learned net. You should implement the SnapshotSolverState()</span></div><div class="line"><a name="l00066"></a><span class="lineno">   66</span>&#160;  <span class="comment">// function that produces a SolverState protocol buffer that needs to be</span></div><div class="line"><a name="l00067"></a><span class="lineno">   67</span>&#160;  <span class="comment">// written to disk together with the learned net.</span></div><div class="line"><a name="l00068"></a><span class="lineno">   68</span>&#160;  <span class="keywordtype">void</span> Snapshot();</div><div class="line"><a name="l00069"></a><span class="lineno">   69</span>&#160;  <span class="keyword">virtual</span> ~<a class="code" href="classcaffe_1_1Solver.html">Solver</a>() {}</div><div class="line"><a name="l00070"></a><span class="lineno">   70</span>&#160;  <span class="keyword">inline</span> <span class="keyword">const</span> SolverParameter&amp; param()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> param_; }</div><div class="line"><a name="l00071"></a><span class="lineno">   71</span>&#160;  <span class="keyword">inline</span> shared_ptr&lt;Net&lt;Dtype&gt; &gt; net() { <span class="keywordflow">return</span> net_; }</div><div class="line"><a name="l00072"></a><span class="lineno">   72</span>&#160;  <span class="keyword">inline</span> <span class="keyword">const</span> vector&lt;shared_ptr&lt;Net&lt;Dtype&gt; &gt; &gt;&amp; test_nets() {</div><div class="line"><a name="l00073"></a><span class="lineno">   73</span>&#160;    <span class="keywordflow">return</span> test_nets_;</div><div class="line"><a name="l00074"></a><span class="lineno">   74</span>&#160;  }</div><div class="line"><a name="l00075"></a><span class="lineno">   75</span>&#160;  <span class="keywordtype">int</span> iter()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> iter_; }</div><div class="line"><a name="l00076"></a><span class="lineno">   76</span>&#160;</div><div class="line"><a name="l00077"></a><span class="lineno">   77</span>&#160;  <span class="comment">// Invoked at specific points during an iteration</span></div><div class="line"><a name="l00078"></a><span class="lineno"><a class="line" href="classcaffe_1_1Solver_1_1Callback.html">   78</a></span>&#160;  <span class="keyword">class </span><a class="code" href="classcaffe_1_1Solver_1_1Callback.html">Callback</a> {</div><div class="line"><a name="l00079"></a><span class="lineno">   79</span>&#160;   <span class="keyword">protected</span>:</div><div class="line"><a name="l00080"></a><span class="lineno">   80</span>&#160;    <span class="keyword">virtual</span> <span class="keywordtype">void</span> on_start() = 0;</div><div class="line"><a name="l00081"></a><span class="lineno">   81</span>&#160;    <span class="keyword">virtual</span> <span class="keywordtype">void</span> on_gradients_ready() = 0;</div><div class="line"><a name="l00082"></a><span class="lineno">   82</span>&#160;</div><div class="line"><a name="l00083"></a><span class="lineno">   83</span>&#160;    <span class="keyword">template</span> &lt;<span class="keyword">typename</span> T&gt;</div><div class="line"><a name="l00084"></a><span class="lineno">   84</span>&#160;    <span class="keyword">friend</span> <span class="keyword">class </span><a class="code" href="classcaffe_1_1Solver.html">Solver</a>;</div><div class="line"><a name="l00085"></a><span class="lineno">   85</span>&#160;  };</div><div class="line"><a name="l00086"></a><span class="lineno">   86</span>&#160;  <span class="keyword">const</span> vector&lt;Callback*&gt;&amp; callbacks()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> callbacks_; }</div><div class="line"><a name="l00087"></a><span class="lineno">   87</span>&#160;  <span class="keywordtype">void</span> add_callback(<a class="code" href="classcaffe_1_1Solver_1_1Callback.html">Callback</a>* value) {</div><div class="line"><a name="l00088"></a><span class="lineno">   88</span>&#160;    callbacks_.push_back(value);</div><div class="line"><a name="l00089"></a><span class="lineno">   89</span>&#160;  }</div><div class="line"><a name="l00090"></a><span class="lineno">   90</span>&#160;</div><div class="line"><a name="l00091"></a><span class="lineno">   91</span>&#160;  <span class="keywordtype">void</span> CheckSnapshotWritePermissions();</div><div class="line"><a name="l00095"></a><span class="lineno"><a class="line" href="classcaffe_1_1Solver.html#a733bef9a2e7dea29f52ed46a922d96f7">   95</a></span>&#160;  <span class="keyword">virtual</span> <span class="keyword">inline</span> <span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code" href="classcaffe_1_1Solver.html#a733bef9a2e7dea29f52ed46a922d96f7">type</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <span class="stringliteral">&quot;&quot;</span>; }</div><div class="line"><a name="l00096"></a><span class="lineno">   96</span>&#160;</div><div class="line"><a name="l00097"></a><span class="lineno">   97</span>&#160; <span class="keyword">protected</span>:</div><div class="line"><a name="l00098"></a><span class="lineno">   98</span>&#160;  <span class="comment">// Make and apply the update value for the current iteration.</span></div><div class="line"><a name="l00099"></a><span class="lineno">   99</span>&#160;  <span class="keyword">virtual</span> <span class="keywordtype">void</span> ApplyUpdate() = 0;</div><div class="line"><a name="l00100"></a><span class="lineno">  100</span>&#160;  <span class="keywordtype">string</span> SnapshotFilename(<span class="keyword">const</span> <span class="keywordtype">string</span> extension);</div><div class="line"><a name="l00101"></a><span class="lineno">  101</span>&#160;  <span class="keywordtype">string</span> SnapshotToBinaryProto();</div><div class="line"><a name="l00102"></a><span class="lineno">  102</span>&#160;  <span class="keywordtype">string</span> SnapshotToHDF5();</div><div class="line"><a name="l00103"></a><span class="lineno">  103</span>&#160;  <span class="comment">// The test routine</span></div><div class="line"><a name="l00104"></a><span class="lineno">  104</span>&#160;  <span class="keywordtype">void</span> TestAll();</div><div class="line"><a name="l00105"></a><span class="lineno">  105</span>&#160;  <span class="keywordtype">void</span> Test(<span class="keyword">const</span> <span class="keywordtype">int</span> test_net_id = 0);</div><div class="line"><a name="l00106"></a><span class="lineno">  106</span>&#160;  <span class="keyword">virtual</span> <span class="keywordtype">void</span> SnapshotSolverState(<span class="keyword">const</span> <span class="keywordtype">string</span>&amp; model_filename) = 0;</div><div class="line"><a name="l00107"></a><span class="lineno">  107</span>&#160;  <span class="keyword">virtual</span> <span class="keywordtype">void</span> RestoreSolverStateFromHDF5(<span class="keyword">const</span> <span class="keywordtype">string</span>&amp; state_file) = 0;</div><div class="line"><a name="l00108"></a><span class="lineno">  108</span>&#160;  <span class="keyword">virtual</span> <span class="keywordtype">void</span> RestoreSolverStateFromBinaryProto(<span class="keyword">const</span> <span class="keywordtype">string</span>&amp; state_file) = 0;</div><div class="line"><a name="l00109"></a><span class="lineno">  109</span>&#160;  <span class="keywordtype">void</span> DisplayOutputBlobs(<span class="keyword">const</span> <span class="keywordtype">int</span> net_id);</div><div class="line"><a name="l00110"></a><span class="lineno">  110</span>&#160;  <span class="keywordtype">void</span> UpdateSmoothedLoss(Dtype loss, <span class="keywordtype">int</span> start_iter, <span class="keywordtype">int</span> average_loss);</div><div class="line"><a name="l00111"></a><span class="lineno">  111</span>&#160;</div><div class="line"><a name="l00112"></a><span class="lineno">  112</span>&#160;  SolverParameter param_;</div><div class="line"><a name="l00113"></a><span class="lineno">  113</span>&#160;  <span class="keywordtype">int</span> iter_;</div><div class="line"><a name="l00114"></a><span class="lineno">  114</span>&#160;  <span class="keywordtype">int</span> current_step_;</div><div class="line"><a name="l00115"></a><span class="lineno">  115</span>&#160;  shared_ptr&lt;Net&lt;Dtype&gt; &gt; net_;</div><div class="line"><a name="l00116"></a><span class="lineno">  116</span>&#160;  vector&lt;shared_ptr&lt;Net&lt;Dtype&gt; &gt; &gt; test_nets_;</div><div class="line"><a name="l00117"></a><span class="lineno">  117</span>&#160;  vector&lt;Callback*&gt; callbacks_;</div><div class="line"><a name="l00118"></a><span class="lineno">  118</span>&#160;  vector&lt;Dtype&gt; losses_;</div><div class="line"><a name="l00119"></a><span class="lineno">  119</span>&#160;  Dtype smoothed_loss_;</div><div class="line"><a name="l00120"></a><span class="lineno">  120</span>&#160;</div><div class="line"><a name="l00121"></a><span class="lineno">  121</span>&#160;  <span class="comment">// A function that can be set by a client of the Solver to provide indication</span></div><div class="line"><a name="l00122"></a><span class="lineno">  122</span>&#160;  <span class="comment">// that it wants a snapshot saved and/or to exit early.</span></div><div class="line"><a name="l00123"></a><span class="lineno">  123</span>&#160;  ActionCallback action_request_function_;</div><div class="line"><a name="l00124"></a><span class="lineno">  124</span>&#160;</div><div class="line"><a name="l00125"></a><span class="lineno">  125</span>&#160;  <span class="comment">// True iff a request to stop early was received.</span></div><div class="line"><a name="l00126"></a><span class="lineno">  126</span>&#160;  <span class="keywordtype">bool</span> requested_early_exit_;</div><div class="line"><a name="l00127"></a><span class="lineno">  127</span>&#160;</div><div class="line"><a name="l00128"></a><span class="lineno">  128</span>&#160;  <span class="comment">// Timing information, handy to tune e.g. nbr of GPUs</span></div><div class="line"><a name="l00129"></a><span class="lineno">  129</span>&#160;  <a class="code" href="classcaffe_1_1Timer.html">Timer</a> iteration_timer_;</div><div class="line"><a name="l00130"></a><span class="lineno">  130</span>&#160;  <span class="keywordtype">float</span> iterations_last_;</div><div class="line"><a name="l00131"></a><span class="lineno">  131</span>&#160;</div><div class="line"><a name="l00132"></a><span class="lineno">  132</span>&#160;  DISABLE_COPY_AND_ASSIGN(<a class="code" href="classcaffe_1_1Solver.html">Solver</a>);</div><div class="line"><a name="l00133"></a><span class="lineno">  133</span>&#160;};</div><div class="line"><a name="l00134"></a><span class="lineno">  134</span>&#160;</div><div class="line"><a name="l00135"></a><span class="lineno">  135</span>&#160;}  <span class="comment">// namespace caffe</span></div><div class="line"><a name="l00136"></a><span class="lineno">  136</span>&#160;</div><div class="line"><a name="l00137"></a><span class="lineno">  137</span>&#160;<span class="preprocessor">#endif  // CAFFE_SOLVER_HPP_</span></div><div class="ttc" id="classcaffe_1_1Timer_html"><div class="ttname"><a href="classcaffe_1_1Timer.html">caffe::Timer</a></div><div class="ttdef"><b>Definition:</b> benchmark.hpp:10</div></div>
<div class="ttc" id="namespacecaffe_html"><div class="ttname"><a href="namespacecaffe.html">caffe</a></div><div class="ttdoc">A layer factory that allows one to register layers. During runtime, registered layers can be called b...</div><div class="ttdef"><b>Definition:</b> blob.hpp:14</div></div>
<div class="ttc" id="classcaffe_1_1Solver_1_1Callback_html"><div class="ttname"><a href="classcaffe_1_1Solver_1_1Callback.html">caffe::Solver::Callback</a></div><div class="ttdef"><b>Definition:</b> solver.hpp:78</div></div>
<div class="ttc" id="classcaffe_1_1Solver_html"><div class="ttname"><a href="classcaffe_1_1Solver.html">caffe::Solver</a></div><div class="ttdoc">An interface for classes that perform optimization on Nets. </div><div class="ttdef"><b>Definition:</b> solver.hpp:42</div></div>
<div class="ttc" id="classcaffe_1_1Solver_html_a733bef9a2e7dea29f52ed46a922d96f7"><div class="ttname"><a href="classcaffe_1_1Solver.html#a733bef9a2e7dea29f52ed46a922d96f7">caffe::Solver::type</a></div><div class="ttdeci">virtual const char * type() const</div><div class="ttdoc">Returns the solver type. </div><div class="ttdef"><b>Definition:</b> solver.hpp:95</div></div>
<div class="ttc" id="namespacecaffe_html_a79ce9ffbdd44b367252e0b8cf99bf430"><div class="ttname"><a href="namespacecaffe.html#a79ce9ffbdd44b367252e0b8cf99bf430">caffe::ActionCallback</a></div><div class="ttdeci">boost::function&lt; SolverAction::Enum()&gt; ActionCallback</div><div class="ttdoc">Type of a function that returns a Solver Action enumeration. </div><div class="ttdef"><b>Definition:</b> solver.hpp:33</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu Aug 3 2017 23:11:19 for Caffe by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.13
</small></address>
</body>
</html>
